Fzzy Config/me.fzzyhmstrs.fzzy_config.annotations/RequiresAction

RequiresAction

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CLASS])
annotation class RequiresAction(val action: Action)

Properties fields marked with RequiresAction will prompt the user that changes will require a certain action as defined by the Action enum selected

Classes marked with RequiresAction will prompt the user that changes will require a certain action as defined by the Action enum selected, if any of their containing properties/fields are changed

Actions have a priority based on their enum ordinal (Action.RESTART as the highest priority). If a property/field has an action of higher priority than the config class top level RequiresAction, the settings action will take priority for that setting.

On local sync (loading into the world), if a property doesn't match between synced data and locally loaded data, and a Action.RESTART is present in the changes, a screen will pop up prompting a restart

Author

fzzyhmstrs

Since

0.4.0

Parameters

action

Action the action the user needs to take if this setting or a setting in this config is changed

Properties

Link copied to clipboard
val action: Action